Get Subscriber Details

This API is used to retrieve the details of a single subscriber, including plans (individual or pool offers). If the requested subscriber {value} also exists under a sub-customer, the subscriber details will also be provided.

HTTP URL
GET	/api/v2/subscriber/{type}/{value}

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

Eligibility

The Requester is eligible to request information on own subscribers and own sub-customers’ subscribers.

API Request

This API has no request structure.

API Response

Response Structure

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
content	Object	O	Array of main response body object displayed when an API call was successful. For a failure, it will be empty.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Content data objects

Element	Type	M/O/CM	Description
subscriberIdentifiers	Object	M	Subscriber unique keys
customerId	UUID	M	Parent customer ID.
customerName	String	M	Parent customer name
subsStatus	String	M	LCP status. Valid ENUM values: ACTIVE, SUSPEND, INACTIVE, TERMINATED
tags	String	O	List of tags
systemLabels	String	O	Array of system label names. Comma separated.
userLabels	String	O	Array of user label names. Comma separated.
alias	String	O	Subscriber alias for more easily identifying the subscriber by name. May be filled in for the subscriber under the requesting customer. Always empty ("null") for a subscriber that exists under a sub-customer.
lastKnownLocation	Object	O	Last known SIM location.
lastConnectedNetwork	Object	O	Last known network SIM connected to.
lastRatType	Numeric	O	Last connected RAT type
lastRatTypeLabel	String	O	Last connected RAT type name (label)
lastDataRatType	String	O	Last connected Data RAT type id for data session
lastDataRatTypeLabel	String	O	Last connected Data RAT type name (label) for data session
lastApn	String	O	Last connected Access Point Name
isInDataSession	Boolean	O	Specifies whether subscriber has an open data session True = Subscriber has an open data session False = Subscriber does not have an open data session. The last recorded data session End Time is then specified in lastDataSession
lastDataSession	DateTime	O	Last closed recorded data session date and time (End Time)
lastIp	String	O	Last IP Address
offer	Object	O	Array of subscriber offers
contact	Object	O	Array of subscriber contact details
customFields	Object	O	Placeholder array of generic object used for customization purposes (future feature)
firstActivatedTime	DateTime	O	Date and time of the first activation signal received from the SIM

Subscriber identifiers data objects

Element	Type	M/O/CM	Description
subscriberId	UUID	M	Subscriber Universal Unique ID
imsiMsisdnPairs	Object	M	Array of IMSI and MSISDN pairs object; only one can be marked as active (at the most)
iccid	String	M	SIM card serial number
imei	String	O	Device ID registered on the subscriber
imeisv	String	O	Device ID including software version registered on the subscriber

imsiMsisdnPairs objects

Element	Type	M/O/CM	Description
imsi	String	M	IMSI registered on the SIM card
msisdn	String	O	Subscriber mobile number: MSISDNFormat: International E.164
isLastActive	Boolean	M	Last known IMSI as active indication; only one can be active at a time.True = Last Active IMSIFalse = Inactive IMSI

Last known location data objects

Element	Type	M/O/CM	Description
longitude	Decimal	O	SIM card longitude
latitude	Decimal	O	SIM card latitude

Last connected network data objects

Element	Type	M/O/CM	Description
mcc	String	O	Last connected MCC
mnc	String	O	Last connected MNC
lac	String	O	Last connected LAC
cid	String	O	Last connected CID

Offer data objects

Element	Type	M/O/CM	Description
id	UUID	M	Offer ID as defined in Product Catalog
name	String	M	Offer name
description	String	O	Offer description
attachTimestamp	Datetime	O	Attach offer timestamp Format: YYYY-MM-DD HH:MM:SS.ms
renewalDate	Date	O	Next renewal date
expirationDate	Date	O	Expiration date
priority	Numeric	M	Plan consumption order
linkedOfferIDs	UUID	O	Array of linked offer IDs that are assigned to this offer. An empty array means that there is no offer linked to this offer.

Contact details data objects

Element	Type	M/O/CM	Description
id	UUID	M	Contact ID
emailAddress	String	O	Contact email address
type	String	M	Contact type, whether owner of the customer or a member. ENUM: OWNER, MEMBER
role	String	M	Eligible to enter the self-care application. ENUM: SELFCARE, NONE
salutation	String	O	Contact salutation. ENUM: MR, MS
firstName	String	O	Contact first name
middleName	String	O	Contact middle name
lastName	String	O	Contact last name
identity	Object	M	Array of contact identity numbers
gender	String	O	Contact gender.
birthdate	Date	O	Contact date of birth. Format: DDMMYYYY
landlinePhoneNumber	String	CM	CBR reachable phone number. Mandatory if mobilePhoneNumber is not provided
mobilePhoneNumber	String	CM	CBR reachable phone number. Mandatory if landlinePhoneNumber is not provided. Format: International E.164
additionalPhoneNumber	String	O	Additional phone number where the contact can be reached
picture	String	O	Contact photograph (future feature)
remarks	String	O	General remarks

Identity data objects

Element	Type	M/O/CM	Description
idType	String	M	Identity type: ENUM: NATIONAL_IDPASSPORTDRIVER_LICENSE
idNumber	String	M	ID number

Custom fields data objects (future feature)

Element	Type	M/O/CM	Description
keyName	String	O	Name of the custom element
keyValue	String	O	Custom element value

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
SUBSCRIBER_1002	Subscriber does not exist
SUBSCRIBER_1006	Failed to retrieve subscriber details

Examples

Request Body

Copy

{
}

Response Body: Success ACK

Copy

{
  "errorCode": "",
  "errorMessage": "",
  "content": [
    {
      "subscriberIdentifiers": {
        "subscriberId": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
        "imsiMsisdnPairs": [
          {
            "imsi": "222013090961859",
            "msisdn": "999013090961859",
            "isLastActive": true
          },
          {
            "imsi": "310380501118337",
            "msisdn": "134044411258337",
            "isLastActive": false
          }
        ],
        "iccid": "8935711001000034535",
        "imei": "354306110218529",
        "imeisv": "3543061102185201"
      },
      "customerId": "d7fcef24-5c03-41dd-9e33-995b7d6f47a4",
      "customerName": "Motorola",
      "subsStatus": "ACTIVE",
      "systemLabels": [
        "LPWA",
        "4FF"
      ],
      "userLabels": [
        "user label 1",
        "user label 2"
      ],
      "alias": "Camera1",
      "lastKnownLocation": {
        "longitude": 230,
        "latitude": 70.5
      },
      "lastConnectedNetwork": {
        "mcc": "257",
        "mnc": "02",
        "lac": "16",
        "cid": "2224"
      },
      "lastRatType": "GSM",
      "lastRatTypeLabel": "3G (UTRAN 1)",
      "lastDataRatType": "6",
      "lastDataRatTypeLabel": "4G (WB-EUTRAN 6)",
      "lastApn": "flolive.net",
      "isInDataSession": false,
      "lastDataSession": "2020-11-10 09:47:46.668866",
      "lastDataSessionRecord": "2020-11-10 09:48:42.365876",
      "lastIp": "10.84.8.208",
      "firstActivatedTime": "2020-07-11 09:48:42.365876",
      "offer": [
        {
          "id": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
          "name": "roaming 20GB",
          "description": "roaming bundle 20 GB",
          "attachTimestamp": "2020-11-11 08:47:46.758866",
          "renewalDate": "23122023",
          "expirationDate": "23052024",
          "priority": 100,
          "linkedOfferIds": [
            "d7ecef34-5b23-21ae-9e53-905a7d6d43a8",
            "e1eceff4-5c13-29ee-1d53-901a7a3b13a0"
          ]
        },
        {
          "id": "e7fcef24-5c03-41dd-9e33-995b7d6f46b6",
          "name": "Data 10GB",
          "description": "Data Add-on 10 GB",
          "attachTimestamp": "2020-11-08 08:12:48.758823",
          "renewalDate": "23122023",
          "expirationDate": "23052024",
          "priority": 200,
          "linkedOfferIds": null
        }
      ],
      "contact": {
        "id": "e7fcef24-5c03-41dd-9e33-995b7d6f46e2",
        "emailAddress": "shaul.cohen@flolive.net",
        "type": "OWNER",
        "role": "NONE",
        "salutation": "MR",
        "firstName": "Shaul",
        "middleName": "",
        "lastName": "Cohen",
        "identity": [
          {
            "idType": "PASSPORT",
            "idNumber": "123456789"
          },
          {
            "idType": "NATIONAL_ID",
            "idNumber": "987654321"
          }
        ],
        "gender": "MALE",
        "birthdate": "28122000",
        "landlinePhoneNumber": "",
        "mobilePhoneNumber": "972542265160",
        "additionalPhoneNumber": "",
        "picture": "",
        "remarks": ""
      },
      "customFields": [
        {
          "keyName": "custom-property1",
          "keyValue": "custom-value"
        },
        {
          "keyName": "custom-property2",
          "keyValue": "custom-value"
        }
      ]
    },
    {
      "subscriberIdentifiers": {
        "subscriberId": "e7fcef24-5c03-41dd-9e33-995b7d6f32b1",
        "imsiMsisdnPairs": [
          {
            "imsi": "222013090961859",
            "msisdn": "999013090961859",
            "isLastActive": true
          },
          {
            "imsi": "310380501118337",
            "msisdn": "134044411258337",
            "isLastActive": false
          }
        ],
        "iccid": "8935711001000034535",
        "imei": "354306110218531",
        "imeisv": "3543061102185301"
      },
      "customerId": "b8fcef24-5c03-41dd-9e33-956b7d6e47b3",
      "customerName": "Gualas",
      "subsStatus": "ACTIVE",
      "systemLabels": [
        "LPWA",
        "4FF"
      ],
      "alias": null,
      "lastKnownLocation": {
        "longitude": 250,
        "latitude": 86.5
      },
      "lastConnectedNetwork": {
        "mcc": "257",
        "mnc": "02",
        "lac": "16",
        "cid": "2224"
      },
      "lastRatType": "GSM",
      "lastRatTypeLabel": "3G (UTRAN 1)",
      "lastDataRatType": "6",
      "lastDataRatTypeLabel": "4G (WB-EUTRAN 6)",
      "lastApn": "flolive.net",
      "isInDataSession": true,
      "lastDataSession": "2020-11-10 09:47:46.668866",
      "lastDataSessionRecord": "2020-11-10 09:48:42.365876",
      "lastIp": "10.84.8.208",
      "firstActivatedTime": "2020-04-11 09:18:41.115176",
      "offer": [
        {
          "id": "e7fcef24-5c03-41dd-9e33-995b7d6f47a7",
          "name": "roaming 20GB",
          "description": "roaming bundle 20 GB",
          "attachTimestamp": "2020-11-11 08:47:46.758866",
          "renewalDate": "23122023",
          "expirationDate": "23052024",
          "priority": 100,
          "linkedOfferIds": null
        },
        {
          "id": "e7fcef24-5c03-41dd-9e33-995b7d6f46b6",
          "name": "Data 10GB",
          "description": "Data Add-on 10 GB",
          "attachTimestamp": "2020-11-08 08:12:48.758823",
          "renewalDate": "23122023",
          "expirationDate": "23052024",
          "priority": 200,
          "linkedOfferIds": null
        }
      ],
      "contact": {
        "id": "e7fcef24-5c03-41dd-9e33-995b7d6f46e2",
        "emailAddress": "john.flow@flolive.net",
        "type": "OWNER",
        "role": "NONE",
        "salutation": "MR",
        "firstName": "John",
        "middleName": "",
        "lastName": "Flow",
        "identity": [
          {
            "idType": "PASSPORT",
            "idNumber": "123456730"
          },
          {
            "idType": "NATIONAL_ID",
            "idNumber": "987654300"
          }
        ],
        "gender": "MALE",
        "birthdate": "29122002",
        "landlinePhoneNumber": "",
        "mobilePhoneNumber": "972546655163",
        "additionalPhoneNumber": "",
        "picture": "",
        "remarks": ""
      },
      "customFields": [
        {
          "keyName": "custom-property1",
          "keyValue": "custom-value"
        },
        {
          "keyName": "custom-property2",
          "keyValue": "custom-value"
        }
      ]
    }
  ],
  "pageable": {
    "page": 1,
    "size": 10,
    "totalPages": 1,
    "totalElements": 2
  }

Response Body: Failure NAK

Copy

{
  "errorCode": "SUBSCRIBER_1006",
  "errorMessage": "Failed to retrieve subscriber details",
  "content": "",
  "pageable": null
}